eFAWATEERcom BANK API

(0 reviews)

Prepaid Validation

URLs :

Enviroment	Method	URL
Mock	POST	https://eu1.anypoint.mulesoft.com/mocking/api/v1/sources/exchange/assets/4be2e19f-42da-4571-80fd-19077a31ce58/efawateercom-bank-exp-api/1.0.7/m/prepaid/prepaid-validation
Dev	POST	https://maictrldev.capitalbank.jo/efawateercom-bank-api/v1/prepaid/prepaid-validation
Stage	POST	https://maictrlstg.capitalbank.jo/efawateercom-bank-api/v1/prepaid/prepaid-validation
Prod	POST	To be updated

Description : This service allows the channel or Bank itself to initiate a prepaid transaction to validate it before payment by eFAWATEERcom.

The service is intended to involve a set of validations on the potential prepaid payment, if the validation process is successful, eFAWATEERcom will generate and send a validation code in the response message. Before sending the prepaid payment transaction, Bank/PSP should validate the prepaid transaction first using the prepaid validation request. Save the validation Code send it during the payment request.

Mulesoft Request:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id, x-user-id, Authorization, x-debug-flag, x-customer-id

Request Body: application/json

Field Name	Type	Length	Occurrence	Description
prepaidValidation	Object		M
billingInfo	Object		M
acctInfo	Object		M
billingNo	String	50	C	Represents the unique identifier of subscription in a specific service provided by the biller
billerCode	Integer	3	M	Represents the unique code of the Biller
End of acctInfo
dueAmt	Decimal	12,3	O	the due amount of the uploaded bill
serviceTypeDetails	Object		M
serviceType	String	25	M	Represents the service type of the biller
prepaidCat	String	20	C	Represents the prepaid category related to a specific prepaid service of a biller
End of serviceTypeDetails
payerInfo	Object		M
idType	string	3	C	Represents a unique identifier type (The official number used to identify a customer)
id	string	20	C	The identification of the customer based on the chosen value from the IdType field
nation	char	2	C	Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait
name	string	20	M
phone	string	20	O
address	string	100	O
email	string	100	O
joebppsNo	Integer	10	C	Represents the unique identifier of the customer profile in eFAWATEERcom
End of 'payerInfo'
End of ' billingInfo '
End of ' prepaidValidation '

{
"prepaidValidation": {
"billingInfo": {
"acctInfo": {
"billingNo": "07xxxxxxxxx",
"billerCode": 42
},
"dueAmt": 45,
"serviceTypeDetails": {
"serviceType": "Mobile",
"prepaidCat": "JD_5"
},
"payerInfo": {
"joebppsNo": 5484556455
}
}
}
}

Mulesoft Response:

Success Response: (200)

Response Body: application/json

Field Name	Type	Length	Occurrence	Description	Validation
status	Object		M
success	Boolean		M	true false
code	String	10	M	Error Code	“0” incase of success or Error Code
reasonCode	String	50	O	Error Type or Error category	Add this tag only incase of error
arabicMessage	String	200	M	English message translated to Arabic	تمت العملية بنجاح in case of success or arabic translated error in case of known errors
englishMessage	String	200	M	Description about the processing	“The Operation has been Successfully Completed” Or error Description
End of status
response	Object		O		Exists if success = true
prepaidValidation	Object		M
billingInfo	Object		M
result	Object
errorCode	string	3	M
errorDesc	string	100	M
severity	Enum, string	7	M	Enum: Error, Info
End of result
acctInfo	Object		M
billingNo	String	50	C	Represents the unique identifier of subscription in a specific service provided by the biller
billerCode	Integer	3	M	Represents the unique code of the Biller
End of acctInfo
dueAmt	Decimal	12,3	M	the due amount of the uploaded bill
feesAmt	Decimal	12,3	C	Represents the Total Fees Amount on the payment
validationCode	string	50	C	Represents the unique code of the Prepaid transaction used to validate it throughout its cycle
msgLabel	string	500	O	Represents a label or note about a transaction by the biller
serviceTypeDetails	Object		M
serviceType	String	25	M	Represents the service type of the biller
prepaidCat	String	20	C	Represents the prepaid category related to a specific prepaid service of a biller
End of serviceTypeDetails
remittanceInfo	Object		C
sender	Object		M
enName	String	150	M	English Name
arName	String	200	O	Arabic Name
nation	Enum, String	2	M	Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait
idType	Enum, String	3	M
id	string	20	M
End of 'sender'
beneficiary	Object		M
enName	String	150	M
arName	String	200	O
nation	Enum, String	2	M	Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait
End of 'beneficiary'
transferReason	String	100	M	Represent the remittance transfer reason
receivingCountry	Enum, String	2	M	Enum: JO - Jordanian IQ - Iraq GB - British KW - Kuwait
End of 'remittanceInfo'
additionalInfo	Object		O
custName	String	150	M
freeText		300	M	Represents any extra info biller can send
End of 'additionalInfo'
End of billingInfo
End of ' prepaidValidation '
End of ‘ response ‘

{
"status": {
"success": true,
"code": "200",
"arabicMessage": "تمت العملية بنجاح",
"englishMessage": "The Operation has been Successfully Completed"
},
"response": {
"prepaidValidation": {
"billingInfo": {
"result": {
"errorCode": "8",
"errorDesc": "Success",
"severity": "Info"
},
"acctInfo": {
"billingNo": "07xxxxxxxxxx",
"billerCode": "42"
},
"dueAmt": "7.5",
"validationCode": "50421",
"msgLabel": "Sample Message",
"serviceTypeDetails": {
"serviceType": "Mobile",
"prepaidCat": "JD_5"
}
}
}
}
}

Sample Error Response:

Error codes :

400:

content-type: JSON

{
"success": false,
"code": "400",
"reasonCode": "BadRequest",
"arabicMessage": "",
"englishMessage": "Invalid json value was provided"
}

Prepaid Validation

Reviews